Skip to main content
POST
Handles `POST /v1/verifications`.

Authorizations

Authorization
string
header
required

A tenant API key. Acts for exactly one tenant and cannot conclude a case, because a conclusion records a person.

Body

application/json

Verification request body.

document
object
required

Identity document presented.

selfie_image_base64
string
required

Base64-encoded live selfie.

subject_id
string
required

Tenant's customer being verified.

Response

A replayed Idempotency-Key; the original verification

Verification response body.

created_at
string
required

RFC 3339 creation timestamp.

evidence
object[]
required

References to retained evidence.

reasons
object[]
required

Explanation reasons.

status
enum<string>
required

Outcome status.

Available options:
APPROVED,
REVIEW_REQUIRED,
REJECTED,
FAILED
subject_id
string
required

Tenant's customer.

verification_id
string
required

Verification identifier.

decision
null | enum<string>

Decision outcome.

Available options:
ALLOW,
WARN,
BLOCK,
HOLD,
REVIEW_REQUIRED,
FLAG,
BLOCK_RECOMMENDED,
SUSPEND,
END_STREAM
decision_id
string | null

Decision record identifier.

distance
number<float> | null

Face-match distance, when the provider produced one.

document
null | object

Document metadata, without the image itself.

model_version
string | null

Model or vendor version behind the score.

review_case_id
string | null

Manual-review case, when the outcome needs a human.

review_status
null | enum<string>

Review lifecycle state.

Available options:
PENDING,
APPROVED,
OVERTURNED,
NOT_REQUIRED
risk_level
null | enum<string>

Explainable risk level.

Available options:
LOW,
MEDIUM,
HIGH,
CRITICAL